﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////


#pragma once
#include "GcmpRenderingInterface.h"
#include "Color.h"

namespace gcmp
{
    /// \brief 预高亮属性设置接口类
    class GCMP_RENDERING_INTERFACE_EXPORT IPreHighlightSetting
    {
    public:
        /// \brief 析构函数
        virtual ~IPreHighlightSetting();

        /// \brief 是否预高亮边
        /// \return true：预高亮边；false：不预高亮边
        virtual bool IsEdgePreHighlightable() const = 0;

        /// \brief 设置是否预高亮边
        /// \param isPreHighlightable 是否预高亮边
        virtual void SetEdgePreHighlightable(bool isPreHighlightable) = 0;

        /// \brief 是否预高亮面
        /// \return true：预高亮面；false：不预高亮面
        virtual bool IsFacePreHighlightable() const = 0;

        /// \brief 设置是否预高亮面
        /// \param isPreHighlightable 是否预高亮面
        virtual void SetFacePreHighlightable(bool isPreHighlightable) = 0;

        /// \brief 预高亮效果是否能被遮挡
        /// \return true:是；false：否
        virtual bool IsPreHighlightEffectCoverable() const = 0;
        
        /// \brief 设置预高亮效果是否能被遮挡
        /// \param isCoverable 预高亮效果是否能被遮挡
        /// \note 如果对象本身不能被遮挡，则高亮效果也不能被遮挡
        virtual void SetPreHighlightEffectCoverable(bool isCoverable) = 0;

        /// \brief 获取面预高亮的颜色
        /// 
        /// 只针对单独面预高亮时有效
        /// \return 预高亮的颜色
        virtual Color GetFacePreHighlightColor() const = 0;

        /// \brief 设置面预高亮的颜色
        /// 
        /// 只针对单独面预高亮时有效
        /// \param color 预高亮的颜色
        virtual void SetFacePreHighlightColor(const Color& color) = 0;

        /// \brief 获取是否使用面预高亮的颜色
        /// 
        /// 只针对单独面预高亮时有效
        /// \return true - 使用设置的面预高亮的颜色，false - 使用设置的统一的预高亮的颜色
        virtual bool UseFacePreHighlightColor() const = 0;

        /// \brief 设置是否使用面预高亮的颜色
        /// 
        /// 只针对单独面预高亮时有效
        /// \param useFacePreHighlightColor true - 使用设置的面预高亮的颜色，false - 使用设置的统一的预高亮的颜色
        virtual void SetUseFacePreHighlightColor(bool useFacePreHighlightColor) = 0;
    };
}

